/*
 * Copyright 2007 Dan Hodge
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.datajanitor.baja.spi;

import net.datajanitor.baja.spi.data.AuthInfo;

/**
 * Implements an authentication strategy. 
 */
public interface Authenticator {
    /**
     * Provides a unique key for this authenticator.
     * @return A unique key, suitable for caching
     */
    public String getKey();
    
    /**
     * Executes the authentication strategy using the supplied connection provider.
     * @param provider The connection provider
     * @return A valid, initialized AuthInfo object if the authentication succeeds
     * @throws BoxSpiException If the authentication fails
     */
    public AuthInfo authenticate(BoxConnectionProvider provider) throws BoxSpiException;
}
